home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 027a / spelclip.zip / SPELCLIP.TXT < prev   
Text File  |  1990-09-08  |  20KB  |  572 lines
  1. ClipWord (TM) & SpellClip (TM)
  2.  
  3. The Word Processor and Spelling Checker for Clipper Developer's
  4. Applications.
  5.  
  6. From Action Plus Software
  7. The Information Management Company
  8.  
  9. ClipWord includes . . .
  10.  
  11.      Clipper Source Code
  12.      Sample Demo Program
  13.      Bold Face
  14.      Underlining
  15.      Field Merging
  16.      Margin Settings
  17.      Import & Export
  18.      Uses MemoEdit
  19.      On-Screen Template
  20.      Easy User Interface
  21.  
  22.  
  23.  
  24. SpellClip includes . . .
  25.  
  26.      Source Code
  27.      WordPerfect-like User Interface
  28.      Built-In Dictionary - 24,000+ Words
  29.      Add Words on-the-fly
  30.      Highlights Offending Words
  31.      Edit Offending Words
  32.      WildCard Look-Ups
  33.      Build your own Dictionaries with supplied parsing routine
  34.  
  35.  
  36.      ╔════════════════════════════╗
  37.      ║    Companion Products      ║
  38.      ╠════════════════════════════╣
  39.      ║  ClipWord Price:  $99.95   ║
  40.      ║  SpellClip Price: $99.95   ║
  41.      ╚════════════════════════════╝ Quick Start Instructions
  42. Welcome to ClipWord / SpellClip, the word processor and spelling
  43. checker for Clipper(R) applications.
  44.  
  45. Please follow the next few instructions to get started with this
  46. new program. 
  47.  
  48. 1st: Make sure that you back up your master 
  49.      distribution diskettes.
  50.  
  51. 2nd: Copy the contents of the distribution disk to a new
  52.      sub-directory on your hard disk.  (You can call it whatever
  53.      you like.)
  54.  
  55. 3rd: Run the SPELLCLP.EXE file.  It is a self-unarchiving utility
  56.      that will decompress the necessary files for your use.  This
  57.      file was compressed using PKZIP.
  58.  
  59. 4th: Type COMPILE  [Enter].  This will create a standalone
  60.      SAMPLE.EXE program using SAMPLE.PRG and SPELLCLP.PRG.  You may
  61.      wish to review the contents of the COMPILE.BAT file to modify
  62.      it to use another linker.  It assumes that you will be using
  63.      TLINK and that your Clipper libraries are located in
  64.      C:\TOOLS\.  This obviously may not be the case so modify the
  65.      file to fit your circumstances.
  66.  
  67.      After the program is compiled, the new SAMPLE.EXE program will
  68.      be automatically loaded for you.  You should first select the
  69.      INDEX DICTIONARY option on the menu because the DICTIONARY
  70.      index files are not shipped with the program.  They must be
  71.      created before you attempt to use the spelling checker.
  72.  
  73.  
  74. WARRANTY
  75.  
  76. Action Plus Software warrants that the original diskettes are free
  77. from defects in material and workmanship, assuming normal use, for
  78. a period of ninety (90) days from the date of purchase.  If a
  79. defect occurs during this period, you may return your faulty
  80. diskette to Action Plus Software, along with a dated proof of
  81. purchase, where it will be replaced free of charge.
  82.  
  83.  
  84. NOTICE
  85.  
  86. Action Plus Software make no representations or warranties, express
  87. or implied, with respect to ClipWord / SpellClip, or this manual
  88. including but not limited to warranties of merchantability or
  89. fitness for a particular purpose.  Action Plus Software reserve
  90. unto themselves the right to make periodic changes, revisions,
  91. enhancements and alterations of any kind to ClipWord / SpellClip
  92. and or its manual without obligation to notify any person,
  93. institution or organization of such changes, revisions,
  94. enhancements and alterations to the product.
  95.  
  96. The program is provided "as is" without warranty of any kind,
  97. either expressed or implied, including, but not limited to the
  98. implied warranties of merchantability and fitness for a particular
  99. purpose.
  100.  
  101. The entire risk as to the quality and performance of the program is
  102. with you.  Should the program prove defective, you (and not Action
  103. Plus Software) assume the entire cost of all necessary servicing,
  104. repair or correction.  Action Plus Software does not warrant that
  105. the functions contained in the program will meet your requirements
  106. or that the operation of the program will be uninterrupted or error
  107. free.
  108.  
  109.  
  110.  
  111. Copy Protection
  112.  
  113. ClipWord / SpellClip is not copy protected.  You may make backup
  114. copies of this software.  This software is sold to be used on a
  115. single computer.  Please do not abuse the trust we place in you by
  116. providing this software to you in an unprotected form.  You may
  117. move this software from one computer to another as long as you
  118. cannot use it on two machines at the same time. Should you decide
  119. to make it possible to use this software on more than one machine
  120. at a time you would be breaking the law.  It is not legal to give
  121. a copy of this software SOURCE CODE to another person.  You have
  122. purchased the right to use the software, you did not purchase the
  123. rights of authorship or distributorship OF SOURCE CODE.  Please act
  124. accordingly.  You are authorized to give or sell copies of your
  125. COMPILED ORIGINAL APPLICATIONS that include this compiled source
  126. code to others.
  127. License
  128.  
  129. You should read the terms and conditions of this License Agreement
  130. before you use the software.  Your use of the software constitutes
  131. your full and complete acceptance of the terms and conditions of
  132. this License Agreement.  If you do not agree to abide by the terms
  133. of this License Agreement you should immediately return the
  134. unopened software to Action Plus Software, and your purchase price
  135. will be refunded.
  136.  
  137. The purchaser assumes the responsibility for choosing this software
  138. program to achieve the results that they desire.  This includes the
  139. installation, use and results they achieve from the use of the
  140. software program.
  141.  
  142.  
  143. This License Agreement grants you a non-exclusive license to use
  144. this software and permits you to legally do the following things:
  145.  
  146. 1.   Use this software program on one computer at a time as a book
  147.      is used.  If this program is to be used by more than one
  148.      person at one time, each individual using the software must
  149.      have an original copy of the software.
  150.  
  151. 2.   Make archival backup copies of the contents of the  diskettes
  152.      for the sole purpose of protecting the users original copy
  153.      from loss.            
  154.  
  155. 3.   Transfer the program and this license to an other party if the
  156.      other party agrees to accept the terms and conditions of this
  157.      Agreement.  If you transfer the program, you must at the same
  158.      time either transfer all copies whether in printed or
  159.      machine-readable form to the same party or destroy any copies
  160.      not transferred.  
  161.  
  162.      You may not use, copy, modify, or transfer the program except
  163.      when you comply with the terms of this license agreement.
  164.  
  165. 4.   Include the source code contained in SPELLCLIP.PRG and
  166.      SAMPLE.PRG and the dictionary file DICT.DBF in any Clipper or
  167.      other COMPILED program or programs and distribute said
  168.      program(s) royalty free.  All compiled programs must contain
  169.      the copyright notice.
  170.  
  171. The prices for the programs are as follows:
  172.  
  173.           ClipWord                            SpellClip
  174.            $99.95                              $99.95
  175.  
  176. ClipWord 
  177.  
  178. The following are a set of procedures and functions that allow a
  179. memo field to be edited with some of the common word processing
  180. functionallity.  All rights to this software are reserved to ACTION
  181. PLUS SOFTWARE.  Use of this code is limited to those things
  182. specifically agreed to in the License Agreement.
  183.  
  184. (C)Copyright ACTION PLUS SOFTWARE 1988,1989,1990 
  185. All Rights Reserved - 11485 S. High Mountain Drive SANDY,UT
  186. 84092-5675  - (801)572-3303
  187.  
  188.  
  189. Files contained on the distribution disk
  190.  
  191. README.1ST            Errata file containing the latest                 
  192.                       information about the program.
  193.  
  194. SPELLCLP.PRG          The ClipWord & SpellClip source                   
  195.                       code program files.
  196.  
  197. SAMPLE.PRG            The program source file that                      
  198.                       demonstrates how you will integrate               
  199.                       SPELLCLP.PRG into your own                        
  200.                       applications.
  201.  
  202. DICT.DBF              The SpellClip Dictionary Database
  203.  
  204. COMPILE.BAT           A simple batch file that will create              
  205.                       a standalone word processing                      
  206.                       program with all the functionality                
  207.                       of ClipWord and SpellClip.
  208.  
  209.  
  210. MAKEDICT.EXE          A standalone program that will                    
  211.                       permit you to create your own                     
  212.                       custom dictionaries or add to                     
  213.                       DICT.DBF by "feeding" MAKEDICT.EXE text files
  214.                       from which it will parse unique words.            
  215.  
  216.                       This utility will also generate a                 
  217.                       frequency of usage counter for each               
  218.                       word to indicate which words are                  
  219.                       most commonly used and should                     
  220.                       therefore be placed at the top of                 
  221.                       the DICT.DBF file for inclusion in                
  222.                       the quick find array.
  223.  
  224. MDICT.DBF             The temporary database used by                    
  225.                       MAKEDICT.EXE which includes the                   
  226.                       counter field not used in DICT.DBF
  227.  
  228. SPELLCLP.TXT          This file.
  229. Scope and purpose of the Program
  230.  
  231. The purpose of these programs is to provide Clipper programmers
  232. will an easy-to-integrate, powerful word processor for their
  233. Clipper applications.  ClipWord contains functions to Add, Edit,
  234. Print, Import, Export, and Save documents.  Within these documents
  235. BOLD, UNDERLINE, Spell Checking, Block operations, Field Merging,
  236. and Margin settings are supported.  Document length is limited by
  237. available memory because of the nature of the memo fields in
  238. Clipper.  We recommend the use of BLINKER to increase the available
  239. memory in your finished application.  We have been able to enter
  240. documents up to 24,000 characters in Action Plus, a very large
  241. application.  We appreciate your interest in our products and
  242. welcome your suggestions.
  243.  
  244.  
  245. PROCEDURE PRINTLET
  246.  
  247. Prints the memo field using bold underline and merged fields Please
  248. check for printer avaliablity and avaliabliity of the variables to
  249. be used in the merge fields.
  250.  
  251. Parameters are:
  252.  
  253. LETTER:    memo field or memory variable to be printed
  254.  
  255. LETLINES:  The lines to leave at the top of the page for                
  256.            letter head.    
  257.  
  258. MPRINTER:  Logical .t. if HP laser .f. for epson codes       
  259.  
  260. The following are variables which must be defined before calling
  261. this procedure:
  262.  
  263.  
  264. RIGHT:          Right margin in spaces
  265.  
  266. LEFT:                 Left margin in spaces       
  267.  
  268. MRGNAMES:       Array containing the names of the                       
  269.                 fields used in the merge when the                       
  270.                 memo field is edited.  This is a                        
  271.                 character array which has the                           
  272.                 word[s] between the merge blocks                        
  273.                 chr(176).
  274.  
  275.            Example:mrgnames[1]='First Name'
  276.  
  277.  
  278. REALNAMES:      Array containing the real values to                     
  279.                 substitute when the merge                               
  280.                 field is found.  This is used as a                      
  281.                 macro and may contain any valid                         
  282.                 database variable, memory variable                      
  283.                 or expression.  The evaluation of an
  284.                 array element must be character.       
  285.  
  286.             Example:realnames[1]='trim(first)'
  287.  
  288.  
  289.  
  290. FUNCTION MKLN
  291. Prepares one line for printing.
  292.  
  293.  
  294.  
  295. FUNCTION FIXL
  296. Adds underline and bold face codes to line after format
  297.  
  298.  
  299.  
  300. FUNCTION MKLTR
  301. Creates letter including merged information from variable letter
  302.  
  303.  
  304.  
  305. FUNCTION MRGFLD
  306. Finds the proper field to merge
  307.  
  308. parameters are:
  309.  
  310.       b  beginning block position
  311.       e  ending block position
  312.  
  313.  
  314. FUNCTION MAIL
  315. This is the main routine for processing a memo field or memory
  316. variable.
  317.  
  318. parameters are:
  319.  
  320. LETTER:    variable containing the letter to be edited.
  321.  
  322. AVAIL:          Which functions are avaliable.  This is a               
  323.                 character variable which contains a list of             
  324.                 1's and 0's indicating which functions can              
  325.                 be used in this process.  The functions in              
  326.                 order are:             
  327.  
  328.                 Help       -     F1
  329.                 Spell      -     F2
  330.                 Block      -     F3
  331.                 DOS        -     F4  
  332.                 (Not used in this program but recommended. 
  333.                 Use Dr. Switch to implement this for yourself. 
  334.                 (Call 212 787-6633 )
  335.  
  336.                 Files      -     F5
  337.                 Bold       -     F6
  338.                 Underline  -     F7
  339.                 Margins    -     F8
  340.                 Merge      -     F9
  341.  
  342.            Example:avail='110100011' 
  343.            help, spell,dos,margins,merge will be made 
  344.            available.      
  345.  
  346.  
  347.  
  348. Program Variables Needed
  349.  
  350. Four variables need to be defined before calling this program.  
  351.  
  352. They are:
  353.  
  354. RIGHT
  355.  
  356. LEFT
  357.  
  358. The variables contain the right and left margins in spaces.
  359.  
  360. MRGNAMES        The name of an array which                              
  361.                 contains the names you want to                          
  362.                 use for merging information into                        
  363.                 your letter.  This array will be used                   
  364.                 to select variables to merge into                       
  365.                 the letter.  It is associated with                      
  366.                 realnames which contains an                             
  367.                 expression which when evaluated                         
  368.                 will be the actual value to include                     
  369.                 in the letter.
  370.  
  371.      Example:   mrgnames[1]='First'
  372.                 mrgnames[2]='Middle'                                    
  373.                 mrgnames[3]='Last'
  374.                 mrgnames[4]="Today's Date"
  375.                 mrgnames[5]='Total Sale'
  376.  
  377.  
  378. The reason for using MRGNAMES and REALNAMES is to permit you to
  379. display meaningful field names to your users to select from for the
  380. field merge operations.  Sometimes the field names used by
  381. programmers don't make sense to non-programmers.  This strategy
  382. makes the interface more intuitive, regardless of the actual field
  383. names used.
  384.  
  385.  
  386. REALNAMES             The name of an array which                        
  387.                       contains an expression which when                 
  388.                       evaluated will give the value                     
  389.                       associated with the same element                  
  390.                       of mrgnames.     
  391.  
  392.      Example:   realnames[1]='trim(first)'
  393.                 realnames[2]='middle'
  394.                 realnames[3]='trim(last)'
  395.                 realnames[4]='dtoc(date())'
  396.                 realnames[5]='str(tot_sale,7,2)'
  397.  
  398.  
  399. FUNCTION KEY SETTINGS:
  400.  
  401. In our applications we always use F1 set to help and F4 set to
  402. shell out to DOS.  The other keys must be set to their normal
  403. values that is f2=-1, f3=-2, f5=-4, f6=-5, f7=-6, f8=-7, f9=-8.
  404.  
  405. In addition F10 is set to chr(23) so that it is used to save and
  406. exit the memoedit function.
  407.  
  408.  
  409. FUNCTION CHKFILE
  410. When EXPORTING with the [F5] FILES option it is necessary to
  411. determine if a file with the same name exists and if so to permit
  412. overwriting or to ask for another name.  FUNCTION CHKFILE performs
  413. these functions.
  414.  
  415.  
  416. PROCEDURE ENDBLOCK
  417. Completes the blocking procedure according to input to blktype. 
  418. The BLOCK OPERATION TYPES are indicated below:               
  419.  
  420.            Move  
  421.            Copy  
  422.            Delete
  423.            Export
  424.  
  425.  
  426.  
  427. FUNCTION BEDITLET
  428. Displays the row and column on the bottom of the screen.  Handles
  429. the 10 function key calls.
  430.  
  431.  
  432.  
  433. FUNCTION EDITLET
  434. Displays the row and column on the bottom of the screen.  Handles
  435. the 10 function key calls.
  436.  
  437.  
  438.  
  439. PROCEDURE CENTERON
  440. Centers on a column
  441.  
  442.  
  443.  
  444. PROCEDURE SETMARGIN
  445. Sets margins
  446.  
  447. You may set margins with a total width of up to 65 characters. 
  448. Right margins may be from 0-50, Left margins may be 10 to 70.
  449.  
  450.  
  451.  
  452. PROCEDURE MRG
  453. Place merge marks in document from selection information
  454.  
  455.  
  456.  
  457.  
  458.  
  459. SpellClip
  460.  
  461.  
  462. PROCEDURE SPELLCHECK
  463.  
  464. Checks a memo for spelling errors
  465.  
  466.  
  467. PROCEDURE CHKWORD
  468. Checks spelling of word.  When an offending word is encountered by
  469. the spelling checker the following options are provided.  Functions
  470. are organized like WordPerfect's Spelling Checker.
  471.  
  472.      Skip:            Permits the user to leave the                     
  473.                       offending word as is.
  474.  
  475.      Skip All:        Permits the user to leave this                    
  476.                       offending word and all future                     
  477.                       occurences of the offending word                  
  478.                       in the current document.    
  479.  
  480.      Add:             Permits the user to ADD the                       
  481.                       offending word to the userÆs                      
  482.                       dictionary (DICT.DBT).      
  483.  
  484.      Edit:            Permits the user to enter the                     
  485.                       document at the position of the                   
  486.                       offending word to make any                        
  487.                       changes they wish.  [F10] returns                 
  488.                       them to the spell checking routine.         
  489.  
  490.      Look Up:         Permits the user to enter a word                  
  491.                       pattern to search for, including                  
  492.                       wildcards.       
  493.  
  494.  
  495. PROCEDURE REPLACEWORD
  496. Replaces the offending word with the replacement word
  497.  
  498.  
  499.  
  500. PROCEDURE EDITWORD
  501. Edit at offending word
  502.  
  503. [F10] Permits the user to Accept Changes 
  504.  
  505. [Esc] Permits the user to Abandon Changes 
  506.  
  507.  
  508.  
  509. FUNCTION SPELLEDIT
  510. Edit spelling checker
  511.  
  512. This routine also displays the INSERT/TYPEOVER mode at the bottom
  513. of the screen.
  514.  
  515. TYPE OVER
  516.  
  517. INSERT   
  518.  
  519.  
  520.  
  521. PROCEDURE DISPWORD
  522. Displays the offending word.
  523.  
  524.  
  525.  
  526. PROCEDURE MAKEBOX
  527. Makes box with shadow
  528.  
  529.  
  530. FUNCTION CHKWILD
  531. Checks a string against another string to see if it matches using
  532. wild cards.  Str1 contains the wild cards
  533.  
  534.  
  535.  
  536. PROCEDURE LOOKUPW
  537. Looks up possible word combinations
  538.  
  539. Enter the word pattern including wild cards (*,?):
  540.  
  541.  
  542.  
  543. PROCEDURE FLIMPORT
  544. Import a file
  545.  
  546. Permits the user to enter a file name to be imported into the
  547. current memo field.  The routine alternatively permits the user to
  548. press [=] to display a directory path, whereupon the program will
  549. display all file names in an alphabetical scrolling selection list
  550. to pick from.
  551.  
  552. It is recommended that you indicate in your on-line HELP that users
  553. should only attempt to IMPORT DOS TEXT files.  If importing
  554. WordPerfect files they should first be saved as DOS TEXT files
  555. after setting the left and right margins at 1.25" using COURIER 10
  556. point font.  This applies to WordPerfect 5.0 and 5.1.  WordPerfect
  557. 4.2 users will want to leave margins at 10 and 74 to provide for a
  558. 65 character line width.  This will eliminate any extra
  559. re-formatting of the document after it is imported.
  560.  
  561. PROCEDURE LETSCR
  562. Creates background screen for letters with function keys available
  563. on the left.
  564.  
  565.  
  566. REPLACEMENTS FOR FUNCKY FUNCTIONS
  567.  
  568.  
  569. The following are functions written to emulate Funcky functions   
  570. which are used in Action Plus.  If you will be compiling using
  571. Funcky you should delete these functions first.  
  572.